home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / djgpp / contrib / pdcurs22 / src / portable / insch.c < prev    next >
Encoding:
C/C++ Source or Header  |  1995-01-26  |  6.2 KB  |  169 lines
  1. /*
  2. ***************************************************************************
  3. * This file comprises part of PDCurses. PDCurses is Public Domain software.
  4. * You may use this code for whatever purposes you desire. This software
  5. * is provided AS IS with NO WARRANTY whatsoever.
  6. * Should this software be used in another application, an acknowledgement
  7. * that PDCurses code is used would be appreciated, but is not mandatory.
  8. *
  9. * Any changes which you make to this software which may improve or enhance
  10. * it, should be forwarded to the current maintainer for the benefit of 
  11. * other users.
  12. *
  13. * The only restriction placed on this code is that no distribution of
  14. * modified PDCurses code be made under the PDCurses name, by anyone
  15. * other than the current maintainer.
  16. * 
  17. * See the file maintain.er for details of the current maintainer.
  18. ***************************************************************************
  19. */
  20. #define    CURSES_LIBRARY    1
  21. #include <curses.h>
  22.  
  23. /* undefine any macros for functions defined in this module */
  24. #undef    insch
  25. #undef    winsch
  26. #undef    mvinsch
  27. #undef    mvwinsch
  28.  
  29. /* undefine any macros for functions called by this module if in debug mode */
  30. #ifdef PDCDEBUG
  31. #  undef    refresh
  32. #  undef    wrefresh
  33. #  undef    move
  34. #  undef    wmove
  35. #endif
  36.  
  37. #ifdef PDCDEBUG
  38. char *rcsid_insch  = "$Id$";
  39. #endif
  40.  
  41. /*man-start*********************************************************************
  42.  
  43.   Name:                                                         insch
  44.  
  45.   Synopsis:
  46.       int insch(chtype ch);
  47.       int winsch(WINDOW *win, chtype ch);
  48.       int mvinsch(int y, int x, chtype ch);
  49.       int mvwinsch(WINDOW *win, int y, int x, chtype ch);
  50.  
  51.   X/Open Description:
  52.      The routine insch() inserts the character ch into the default
  53.      window at the current cursor position and the window cursor is
  54.      advanced.  The character is of the type chtype as containing
  55.      both data and attributes.
  56.  
  57.      The routine winsch() inserts the character ch into the specified
  58.      window at the current cursor position.  The cursor position is
  59.      advanced.
  60.  
  61.      The routine mvinsch() moves the cursor to the specified (y, x)
  62.      position and inserts the character ch into the default window.
  63.      The cursor position is advanced after the character has been
  64.      inserted.
  65.  
  66.      The routine mvwinsch() moves the cursor to the specified (y, x)
  67.      position and inserts the character ch into the specified
  68.      window.  The cursor position is advanced after the character
  69.      has been inserted.
  70.  
  71.      The routine echochar() inserts the character ch into stdscr
  72.      at the current cursor position and a refresh() is called.  
  73.      The cursor position is advanced.
  74.  
  75.      The routine wechochar() inserts the character ch into the
  76.      specified window at the current cursor position and a wrefresh() 
  77.      is called. The cursor position is advanced.
  78.  
  79.      All these routines are similar to putchar().  The following
  80.      information applies to all the routines.
  81.  
  82.      If the cursor moves on to the right margin, an automatic
  83.      newline is performed.  If scrollok is enabled, and a character
  84.      is added to the bottom right corner of the screen, the
  85.      scrolling region will be scrolled up one line.  If scrolling
  86.      is not allowed, ERR will be returned.
  87.  
  88.      If ch is a tab, newline, or backspace, the cursor will be
  89.      moved appropriately within the window.  If ch is a newline,
  90.      the clrtoeol routine is called before the cursor is moved to
  91.      the beginning of the next line.  If newline mapping is off,
  92.      the cursor will be moved to the next line, but the x
  93.      coordinate will be unchanged.  If ch is a tab the cursor is
  94.      moved to the next tab position within the window.  If ch is
  95.      another control character, it will be drawn in the ^X
  96.      notation.  Calling the inch() routine after adding a control
  97.      character returns the representation of the control character,
  98.      not the control character.
  99.  
  100.      Video attributes can be combined with a character by ORing
  101.      them into the parameter.  This will result in these attributes
  102.      being set.  The intent here is that text, including
  103.      attributes, can be copied from one place to another using inch()
  104.      and insch().
  105.  
  106.      NOTE: All these functions are implemented as macros.
  107.  
  108.   PDCurses Description:
  109.      Depending upon the state of the raw character output, 7- or
  110.      8-bit characters will be output.
  111.  
  112.   X/Open Return Value:
  113.      All functions return OK on success and ERR on error.
  114.  
  115.   X/Open Errors:
  116.      No errors are defined for this function.
  117.  
  118.   Portability                             X/Open    BSD    SYS V
  119.                                           Dec '88
  120.       insch                                 Y        Y       Y
  121.       winsch                                Y        Y       Y
  122.       mvinsch                               Y        Y       Y
  123.       mvwinsch                              Y        Y       Y
  124.  
  125. **man-end**********************************************************************/
  126.  
  127. /***********************************************************************/
  128. int    insch(chtype ch)
  129. /***********************************************************************/
  130. {
  131. #ifdef PDCDEBUG
  132.     if (trace_on) PDC_debug("insch() - called\n");
  133. #endif
  134.  
  135.     return( PDC_chins( stdscr, ch, (bool)(!(_cursvar.raw_out))) );
  136. }
  137. /***********************************************************************/
  138. int    winsch(WINDOW *win, chtype ch)
  139. /***********************************************************************/
  140. {
  141. #ifdef PDCDEBUG
  142.     if (trace_on) PDC_debug("winsch() - called\n");
  143. #endif
  144.  
  145.     return( PDC_chins( win, ch, (bool)(!(_cursvar.raw_out))) );
  146. }
  147. /***********************************************************************/
  148. int    mvinsch(int y, int x, chtype ch)
  149. /***********************************************************************/
  150. {
  151. #ifdef PDCDEBUG
  152.     if (trace_on) PDC_debug("mvinsch() - called\n");
  153. #endif
  154.     if (move(y,x) == ERR)
  155.         return(ERR);
  156.     return( PDC_chins( stdscr, ch, (bool)(!(_cursvar.raw_out))) );
  157. }
  158. /***********************************************************************/
  159. int    mvwinsch(WINDOW *win, int y, int x, chtype ch)
  160. /***********************************************************************/
  161. {
  162. #ifdef PDCDEBUG
  163.     if (trace_on) PDC_debug("mvwinsch() - called\n");
  164. #endif
  165.     if (wmove(win,y,x) == ERR)
  166.         return(ERR);
  167.     return( PDC_chins( win, ch, (bool)(!(_cursvar.raw_out))) );
  168. }
  169.